/*
 * Niiuzu
 * Copyright (C) 2011  Thierry Nowak
 * 
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.niiuzu.client.util.widget;

/**
 * Cette interface définit les possibilités d'un composant contenant une liste
 * de valeurs dont l'une d'entre elles est sélectionnée par l'utilisateur.
 * 
 * @param <T>
 *            type des valeurs sélectionnables.
 */
public interface HasSelectedValue<T> {

	/**
	 * Retourne la valeur sélectionnée par l'utilisateur.
	 * 
	 * @return valeur sélectionnée ou <tt>null</tt> si aucune ligne n'est
	 *         sélectionnée.
	 */
	T getSelectedValue();

	/**
	 * Définit la sélection à partir de la valeur.
	 * 
	 * @param selectedValue
	 *            valeur désignant la ligne à sélectionner.
	 */
	void setSelectedValue(T selectedValue);

	/**
	 * Supprime l'ensemble des valeurs qui ont été ajoutés pour ce composant.
	 */
	void clear();

	/**
	 * Ajoute une valeur dans la liste.
	 * 
	 * @param labelItem
	 *            libellé de la ligne désignant la nouvelle valeur.
	 * @param value
	 *            valeur affectée à la ligne.
	 */
	void addValue(String labelItem, T value);

}
